CCM-9861: [API docs] Override channelStatus enum values#934
Merged
Conversation
…n MessageStatus callback
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: CCM-9861 |
simonlabarere
approved these changes
Apr 28, 2025
lapenna-bjss
approved these changes
Apr 28, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Override
channelStatusenum values when used in MessageStatus callbackSummary
When used in the MessageStatus callback, the
channelStatusis populated from the summary information on the RequestItem so will only ever have values for the terminal states:delivered | failed. Currently the documentation states that it could also show the intermediate states.When used on the ChannelStatus callback or the GetStatus endpoint, the payload is populated from the detailed information on the RequestItemPlan so should continue to show the intermediate states.
Previously
Updated
Reviews Required
Checklist